/**

This file is part of MaCI/GIMnet.

MaCI/GIMnet is free software: you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version.

MaCI/GIMnet is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with GIMnet. (See COPYING.LESSER) If not, see 
<http://www.gnu.org/licenses/>.

**/
/**
 *
 * $Id: BearingData.hpp,v 1.4 2009-11-14 14:55:56 ray Exp $
 * 
 * \file
 * \brief Protocol encoder/decoder header for the Bearing protocol.
 * \author Antti Maula <antti.maula@tkk.fi>
 */
#ifndef _MACI_BEARINGDATA_HPP_
#define _MACI_BEARINGDATA_HPP_
#include "BearingTypes.hpp"
#include "MaCIData.hpp"
#include "common/timestamp.hpp"
#include <vector>
#include <map>

namespace gim {
  namespace binbag{class CBinBag;}
}

namespace MaCI {
  namespace Bearing {

    /** Bearing protocol parser.
     *
     * This class contains the methods for decoding/encoding a 
     * Bearing message.
     */
    class CBearingData : public CMaCIData
    {
    public:
      CBearingData();
      ~CBearingData();

      // Copy constructor.
      CBearingData(const CBearingData &);

      // Assignment operator.
      CBearingData &operator=(const CBearingData &);

      // Interface for moving data around
      bool DecodeFrom(gim::binbag::CBinBag *aBinBag);
      void Reset();
      void Print(const int level) const;


      /** Set timestamp element.
       * 
       */
      bool SetTimestamp(const Common::TTimestamp &aStamp);


      /** Set command element.
       * This function stores a element of type TCommand.
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool SetCommand(const TCommand &aCmd);

      /** Set block element.
       * This function stores a element of type TBlock.
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool SetBlock(const TBlock &aData);

      
      bool SetTriBlock(const TTriBlock &aData);

      /** Set BearingEvent element.
       *
       * This function stores a element of type TBearingEvent.
       *
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool SetBearingEvent(const TBearingEvent &aEvent);


      /** Get pointer to TTimestamp element.
       * 
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const MaCI::Common::TTimestamp *GetTimestamp(void) const;
      

      /** Get pointer to TCommand element.
       *
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const TCommand *GetCommand(void) const;

      /** Get pointer to TBlock element.
       *
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const TBlock *GetBlock(void) const;

      const TTriBlock *GetTriBlock(void) const;

      /** Get pointer to TBearingEvent element.
       *
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const TBearingEvent *GetBearingEvent(void) const;

    private:
      const Common::TTimestamp *iTimestampPtr; ///< Pointer to timestamp if exists
      const TCommand *iCommandPtr; ///< Pointer to command if any.
      const TBlock *iBlockPtr; ///< Pointer to data block if any.
      const TTriBlock *iTriBlockPtr; ///< Pointer to data block if any.
      const TBearingEvent *iBearingEventPtr; ///< Pointer to Bearing event.
    };
    
  }
}

#endif
